Include upgrade details in diagnostics bundle during ongoing upgrade #3624

ycombinator · 2023-10-18T00:23:03Z

What does this PR do?

This PR enhances the diagnostics bundle to include upgrade details when Agent is being upgraded.

Why is it important?

To gain more visibility into the Agent upgrade process.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
~~I have made corresponding changes to the documentation~~
~~I have made corresponding change to the default configuration files~~
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
~~I have added an integration test or an E2E test~~

How to test this PR locally

Build elastic-agent from this PR's branch and install it.
Run elastic-agent diagnostics, expand the resulting archive, and check the bundled state.yaml file. Verify that NO upgrade details are included in it by checking that there is no upgrade_details field.
In a new window, upgrade Elastic Agent to a version that hasn't been released yet. This will ensure that the upgrade starts but remains stalled.
```
sudo elastic-agent upgrade 8.13.0
```
In the original window, run elastic-agent diagnostics again, expand the resulting archive, and check the bundled state.yaml file. Verify that upgrade details are included in it by checking that there is an upgrade_details field.

Related issues

Relates to Track and report upgrade details #3119 (comment)

mergify · 2023-10-18T00:23:38Z

This pull request does not have a backport label. Could you fix it @ycombinator? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

elasticmachine · 2023-10-18T00:26:46Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-11-02T17:51:53.165+0000
Duration: 14 min 38 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages.
run integration tests : Run the Elastic Agent Integration tests.
run end-to-end tests : Generate the packages and run the E2E Tests.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2023-10-18T00:49:44Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	98.824% (`84/85`)	👍
Files	67.105% (`204/304`)	👍
Classes	66.19% (`370/559`)	👍
Methods	53.583% (`1174/2191`)	👍
Lines	39.779% (`13762/34596`)	👎 -0.034
Conditionals	100.0% (`0/0`)	💚

mergify · 2023-10-19T18:03:39Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b upgrade-details-in-diagnostics upstream/upgrade-details-in-diagnostics
git merge upstream/main
git push upstream upgrade-details-in-diagnostics

elasticmachine · 2023-10-20T00:49:36Z

Pinging @elastic/elastic-agent (Team:Elastic-Agent)

pchila · 2023-10-23T12:37:15Z

internal/pkg/agent/application/coordinator/coordinator.go

+					FleetMessage:   s.FleetMessage,
+					LogLevel:       s.LogLevel,
+					Components:     compStates,
+					UpgradeDetails: s.UpgradeDetails,


When is this field present? Do we get details about the upgrade after a failure ? Or those get cleared as soon as the grace period is over ?

When is this field present?

This field is populated when the upgrade process starts:

elastic-agent/internal/pkg/agent/application/coordinator/coordinator.go

Lines 475 to 476 in 2a93086

det := details.NewDetails(version, details.StateRequested, actionID)

det.RegisterObserver(c.SetUpgradeDetails)

Do we get details about the upgrade after a failure ?

Yes, if the upgrade process fails at any point, this field will continue to remain populated.

Or those get cleared as soon as the grace period is over ?

I assume you are referring to the Upgrade Watcher's grace period.

Exactly when we clear it out after that is not yet implemented. We need to decide whether we want to clear it out based on some timeout (maybe the grace period or maybe something even beyond that) or due to some user intervention (which could be retrying the upgrade or something else just to clear the upgrade details, not sure yet) or either (whichever happens first).

pchila · 2023-10-23T12:40:18Z

internal/pkg/agent/application/coordinator/coordinator.go

+					FleetMessage   string                 `yaml:"fleet_message"`
+					LogLevel       logp.Level             `yaml:"log_level"`
+					Components     []StateComponentOutput `yaml:"components"`
+					UpgradeDetails *details.Details       `yaml:"upgrade_details,omitempty"`


I don't see any changes in the tests related to this change... could you please add a unit test to document what we can expect in the hook output when UpgradeDetails is populated ?

Thanks. Added in 02625e8.

blakerouse

Nice! Great this is added to the diagnostics.

pchila

LGTM

elastic-sonarqube · 2023-11-02T18:22:57Z

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

ycombinator added the enhancement New feature or request label Oct 18, 2023

mergify bot assigned ycombinator Oct 18, 2023

mergify bot added the backport-skip label Oct 18, 2023

ycombinator added the Team:Elastic-Agent Label for the Agent team label Oct 18, 2023

ycombinator mentioned this pull request Oct 18, 2023

Track and report upgrade details #3119

Closed

3 tasks

ycombinator force-pushed the upgrade-details-in-diagnostics branch from 081d5ec to eebc69e Compare October 20, 2023 00:48

ycombinator marked this pull request as ready for review October 20, 2023 00:49

ycombinator requested a review from a team as a code owner October 20, 2023 00:49

ycombinator requested review from blakerouse and pchila October 20, 2023 00:49

pchila reviewed Oct 23, 2023

View reviewed changes

ycombinator force-pushed the upgrade-details-in-diagnostics branch from eebc69e to 5b1db16 Compare November 1, 2023 06:13

ycombinator requested a review from pchila November 1, 2023 06:14

blakerouse approved these changes Nov 1, 2023

View reviewed changes

pchila approved these changes Nov 2, 2023

View reviewed changes

ycombinator added 9 commits November 2, 2023 23:21

Remove context and handle cancellation internally instead

7bc8fc8

More optimizations

b6bd1ea

Add back context

28ce34f

Adding FSM for upgrades

0ec900a

Implementing TODO

5682966

WIP

ba3e4f7

WIP

ff0a038

Reorganizing imports

1730cd9

Running go mod tidy

3cd9f84

ycombinator added 7 commits November 2, 2023 23:21

Fixing booboos introduced during conflict resolution

b1f368f

Add nil guard

f98765d

Setting logger in test

2f864f0

Include upgrade details in diagnostics bundle

f7dbb2d

Adding CHANGELOG entry

cba774d

Add unit test

f93d5e2

Add godoc

a8aed84

ycombinator force-pushed the upgrade-details-in-diagnostics branch from 5b1db16 to a8aed84 Compare November 2, 2023 17:51

ycombinator merged commit d412c3d into elastic:main Nov 3, 2023
7 checks passed

ycombinator deleted the upgrade-details-in-diagnostics branch November 3, 2023 06:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include upgrade details in diagnostics bundle during ongoing upgrade #3624

Include upgrade details in diagnostics bundle during ongoing upgrade #3624

ycombinator commented Oct 18, 2023 •

edited

Loading

mergify bot commented Oct 18, 2023

elasticmachine commented Oct 18, 2023 •

edited

Loading

Build stats

elasticmachine commented Oct 18, 2023 •

edited

Loading

mergify bot commented Oct 19, 2023

elasticmachine commented Oct 20, 2023

pchila Oct 23, 2023

ycombinator Oct 31, 2023

pchila Oct 23, 2023

ycombinator Nov 1, 2023

blakerouse left a comment

pchila left a comment

elastic-sonarqube bot commented Nov 2, 2023

	det := details.NewDetails(version, details.StateRequested, actionID)
	det.RegisterObserver(c.SetUpgradeDetails)

Include upgrade details in diagnostics bundle during ongoing upgrade #3624

Include upgrade details in diagnostics bundle during ongoing upgrade #3624

Conversation

ycombinator commented Oct 18, 2023 • edited Loading

What does this PR do?

Why is it important?

Checklist

How to test this PR locally

Related issues

mergify bot commented Oct 18, 2023

elasticmachine commented Oct 18, 2023 • edited Loading

💚 Build Succeeded

Build stats

❕ Flaky test report

🤖 GitHub comments

elasticmachine commented Oct 18, 2023 • edited Loading

🌐 Coverage report

mergify bot commented Oct 19, 2023

elasticmachine commented Oct 20, 2023

pchila Oct 23, 2023

Choose a reason for hiding this comment

ycombinator Oct 31, 2023

Choose a reason for hiding this comment

pchila Oct 23, 2023

Choose a reason for hiding this comment

ycombinator Nov 1, 2023

Choose a reason for hiding this comment

blakerouse left a comment

Choose a reason for hiding this comment

pchila left a comment

Choose a reason for hiding this comment

elastic-sonarqube bot commented Nov 2, 2023

ycombinator commented Oct 18, 2023 •

edited

Loading

elasticmachine commented Oct 18, 2023 •

edited

Loading

elasticmachine commented Oct 18, 2023 •

edited

Loading